Inscoper::Config¶

Config class provides information for global configuration. More...

#include <Config.h>

Public Functions¶

	Name
	Config() Default constructor.
void	fromXML(Inscoper::XMLNode & xml) Provide configuration information from an XML node.
void	toXML(Inscoper::XMLNode & xmlParent) Export configuration information in an XML node attached to the parent XML node.
Inscoper::ELogLevel	getAPILogLevel() const Get the log level of the API.
void	setAPILogLevel(Inscoper::ELogLevel apiLogLevel) Set the log level of the API.
const std::vector< std::string > &	getLibraryPaths() const Get the library paths.
void	setLibraryPaths(const std::vector< std::string > & libraryPaths) Set the library paths.
const std::vector< std::string > &	getDriverList() const Get the driver list.
const std::vector< Inscoper::DeviceConfigPtr > &	getDeviceList() const Get the device configuration list.
void	setDeviceList(const std::vector< Inscoper::DeviceConfigPtr > & deviceList) Set the device configuration list.
void	addDeviceConfig(const Inscoper::DeviceConfigPtr & device) Add a device configuration to the list.
const std::string &	getConfigPath() const Get the configuration path.
void	setConfigPath(const std::string & configPath) Set the configuration path.

Detailed Description¶

class Inscoper::Config;

Config class provides information for global configuration.

This class handles the loading, saving, and management of the global configuration for the Inscoper API, including driver lists, device configurations, and log levels.

Public Functions Documentation¶

function Config¶

Config()

Default constructor.

Initializes a new instance of the Config class with default values.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & xml
)

Provide configuration information from an XML node.

Parameters:

xml : an XML node containing configuration information

Exceptions:

InscoperException if an error occurred

Loads the configuration settings from the specified XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Export configuration information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException if an error occurred

Saves the current configuration settings to the specified parent XML node.

function getAPILogLevel¶

Inscoper::ELogLevel getAPILogLevel() const

Get the log level of the API.

Return: The log level of the API

Retrieves the current logging verbosity level used by the API.

function setAPILogLevel¶

void setAPILogLevel(
    Inscoper::ELogLevel apiLogLevel
)

Set the log level of the API.

Parameters:

apiLogLevel : The log level of the API

Updates the logging verbosity level for the API.

function getLibraryPaths¶

const std::vector< std::string > & getLibraryPaths() const

Get the library paths.

Return: The library paths

Retrieves the list of folders where external libraries (e.g., Micro-Manager, Custom drivers) are located.

function setLibraryPaths¶

void setLibraryPaths(
    const std::vector< std::string > & libraryPaths
)

Set the library paths.

Parameters:

libraryPaths : The list of library paths

Sets the list of folders where external libraries (e.g., Micro-Manager, Custom drivers) are located.

function getDriverList¶

const std::vector< std::string > & getDriverList() const

Get the driver list.

Return: The list of drivers

Retrieves the list of available drivers in the configuration.

function getDeviceList¶

const std::vector< Inscoper::DeviceConfigPtr > & getDeviceList() const

Get the device configuration list.

Return: The list of device configurations

Retrieves the list of configured devices.

function setDeviceList¶

void setDeviceList(
    const std::vector< Inscoper::DeviceConfigPtr > & deviceList
)

Set the device configuration list.

Parameters:

deviceList : The list of device configurations

Updates the list of configured devices.

function addDeviceConfig¶

void addDeviceConfig(
    const Inscoper::DeviceConfigPtr & device
)

Add a device configuration to the list.

Parameters:

device : The device configuration to add

Appends a new device configuration to the current list of devices.

function getConfigPath¶

const std::string & getConfigPath() const

Get the configuration path.

Return: The path to the current configuration

Retrieves the folder path to the current configuration.

function setConfigPath¶

void setConfigPath(
    const std::string & configPath
)

Set the configuration path.

Parameters:

configPath : The path to the current configuration

Sets the folder path to the current configuration.

Updated on 2026-04-02 at 10:55:35 +0200